From 71e60e96c719af7417a74d4ef19ba7955b20f751 Mon Sep 17 00:00:00 2001
From: tsteven4 <13596209+tsteven4@users.noreply.github.com>
Date: Sat, 11 Mar 2023 08:26:55 -0700
Subject: [PATCH] document fixes (#1034)
* fix lowrancusr document
with fop we got a bunch of warnings:
... exceed the available area in the inline-progression direction ...
spelling
* add USES_TERMINAL for docs so we get output as the doc generates.
---
CMakeLists.txt | 9 +-
xmldoc/formats/lowranceusr.xml | 371 +++++++++++++++------------------
2 files changed, 175 insertions(+), 205 deletions(-)
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 6171b2928..af5e5ff9c 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -493,17 +493,20 @@ if((CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR) AND NOT _isMultiConfig)
add_custom_target(gpsbabel.org
${CMAKE_SOURCE_DIR}/tools/make_gpsbabel_org.sh ${WEB} ${DOCVERSION}
DEPENDS gpsbabel gpsbabel.pdf
- VERBATIM)
+ VERBATIM
+ USES_TERMINAL)
add_custom_target(gpsbabel.html
${CMAKE_SOURCE_DIR}/tools/make_gpsbabel_html.sh
DEPENDS gpsbabel
- VERBATIM)
+ VERBATIM
+ USES_TERMINAL)
add_custom_target(gpsbabel.pdf
${CMAKE_SOURCE_DIR}/tools/make_gpsbabel_pdf.sh
DEPENDS gpsbabel
- VERBATIM)
+ VERBATIM
+ USES_TERMINAL)
else()
message(WARNING "Document generation is only supported for in-source builds with single configuration generators.")
endif()
diff --git a/xmldoc/formats/lowranceusr.xml b/xmldoc/formats/lowranceusr.xml
index 6bd499e57..f74e7205c 100644
--- a/xmldoc/formats/lowranceusr.xml
+++ b/xmldoc/formats/lowranceusr.xml
@@ -40,8 +40,8 @@ The following provides a high-level description of the multiple USR formats that
User Data File version 4 -
Seems to be the best option for transferring data from older Lowrance units.
- Many of the counts (Number of Waypoints, Number of Routes, etc) were exanded from
- 16-bit integer values (maximum value of 65,535) to 32-bit (maxumum value 2,147,483,647)
+ Many of the counts (Number of Waypoints, Number of Routes, etc) were expanded from
+ 16-bit integer values (maximum value of 65,535) to 32-bit (maximum value 2,147,483,647)
USRv4 and above support a maximum of 20,000 trail-points (actually 24K and change).
USRv4 and above and GPX support trails with trail-segments.
@@ -63,7 +63,7 @@ Some early systems also supported entities called event marker icons.
Event icon markers are represented by symbol, latitude and longitude data only.
By default, event marker icons are converted by GPSBabel to waypoints on read with their name being generated
in the format "Event Marker NNN"
-where NNN is replaced by the squence number of the Event Marker ICON found in the input data.
+where NNN is replaced by the sequence number of the Event Marker ICON found in the input data.
You have the option to ignore Event Icon Markers
effectively removing them from the output data using the input option ignoreicons.
On output, you can use the write option writeasicons to create event marker icons
@@ -86,30 +86,27 @@ The following tables detail the content format of USR data files.
Lowrance USR Data File Contents
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -117,7 +114,7 @@ The following tables detail the content format of USR data files.
X X X X X
USR Format
4
- Identifies the USR file format (interger). Valid values are 2 (USR 2), 3 (USR 3), 4 (USR 4), 5 (USR 5) and 6 (USR 6).
+ Identifies the USR file format (integer). Valid values are 2 (USR 2), 3 (USR 3), 4 (USR 4), 5 (USR 5) and 6 (USR 6).
- - X X X
@@ -266,30 +263,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 2 and 3 Waypoint Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -378,30 +372,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 4, 5 and 6 Waypoint Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -538,30 +529,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 2 and 3 Route Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -650,30 +638,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 4, 5 and 6 Route Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -751,30 +736,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 4, 5 and 6 Route Leg Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -807,30 +789,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 2 and 3 Event Marker ICON Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -859,30 +838,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 2 and 3 Trail Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -930,30 +906,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 2 and 3 Trail Point Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -976,30 +949,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 4, 5 and 6 Trail Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
@@ -1130,30 +1100,27 @@ The following tables detail the content format of USR data files.
Lowrance USR 4, 5 and 6 Trail Point Object Format
-
-
-
-
-
+
+
+
+
+
-
+
- Present In
-
-
-
+ Present In USR Version
+ Field
+ Size (Bytes)
+ Description
- USR 2
- USR 3
- USR 4
- USR 5
- USR 6
- Field
- Size (Bytes)
- Descrption
+ 2
+ 3
+ 4
+ 5
+ 6
--
2.30.2